Skip to main content

FlowGroup Properties

An object defining properties for the FlowGroup class.

TimeoutOptions

Defines the timeout settings for the group.

Type: IFlowTimeoutOptions


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>


EnablePushNotification

Gets or sets a value indicating whether push notification is enabled.

Type: bool


EnableOwnRequest

Specifies whether users can approve their own requests within this group.

Type: bool


ShowInFlowHistory

Indicates whether this group should appear in the workflow history.

Type: bool


HideApporoverInHistory

Determines whether the approver's name is hidden in the workflow history.

Type: bool


TimeoutHour

The number of hours before a timeout occurs.

Type: int


DetailObjects

Detail objects within the workflow group.

Type: List<MembersDetailObjects>


GeolocationOptions

Geolocation options for tracking workflow-related activities.

Type: IFlowGeolocationOptions


NotificationMessage

Gets the notification message associated with the message.

Type: Dictionary<string, string>


PositionGroups

Represents the position groups associated with the workflow group.

Type: MembersPositionGroups


EventsToCheck

List of event IDs that should be checked for the workflow group.

Type: List<string>


MailSubject

Gets the mail subject associated with the message.

Type: Dictionary<string, string>


Positions

Retrieves the positions resolved for the workflow group members.

Type: List<UserPosition>


ConflictStateEventId

Event ID for handling conflict states in the group.

Type: int


Key

A unique identifier for the workflow step.

Type: string


AutoOpenApprovalOption

Specifies whether approvals should open automatically upon group interaction.

Type: int


TimeoutMinute

The number of minutes before a timeout occurs.

Type: int


Name

Name for the workflow step.

Type: string


EmptyGroupEventId

Specifies the event ID triggered when the group is empty.

Type: int


EnableSendMail

Gets or sets a value indicating whether sending mail is enabled.

Type: bool


TableObjects

List of table objects relevant to the workflow group.

Type: List<MembersTableObjects>


Events

Read-only list of events associated with the workflow group.

Type: IReadOnlyList<IEvent>


MailMessage

Gets the mail message associated with the message.

Type: Dictionary<string, string>


TimeoutDuration

The total timeout duration for the group.

Type: TimeSpan


IsCustomMailMessage

Gets or sets a value indicating whether the mail message is custom.

Type: bool


CustomMailMessage

Gets the custom mail message associated with the message.

Type: Dictionary<string, string>


MessageOptions

Gets or sets the message options.

Type: IFlowMessageOptions


RequestIsNecessaryIfDocumentChanged

Specifies if a request is required when the document changes.

Type: bool


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


Documents

List of documents associated with the workflow group.

Type: List<IDocument>


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


WebNotificationOptions

Gets or sets the web notification options.

Type: IFlowWebNotificationOptions


NotificationCaption

Gets the notification caption associated with the message.

Type: Dictionary<string, string>


Attachments

Gets the list of attachments associated with the message.

Type: IReadOnlyList<string>


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

DoNotSendRequestIfProcessed

Indicates whether a request should be avoided if already processed.

Type: bool


CalculateUsingHolidays

Determines whether holiday settings are considered in timeout calculations.

Type: bool


TimeoutDay

The number of days before a timeout occurs.

Type: int


Users

Retrieves the users resolved for the workflow group members.

Type: List<UserInfo>


CalculateUsingWorkingHours

Indicates whether working hours are considered for timeout calculations.

Type: bool


Members

Holds the configuration for members within the group.

Type: FlowMembersOptions


NotificationOptions

Gets or sets the push notification options.

Type: IFlowPushNotificationOptions